Skip to content

Docs: Housekeeping + Remove docs-old#9166

Merged
lstein merged 15 commits into
invoke-ai:mainfrom
joshistoast:chore/remove-old-docs
May 26, 2026
Merged

Docs: Housekeeping + Remove docs-old#9166
lstein merged 15 commits into
invoke-ai:mainfrom
joshistoast:chore/remove-old-docs

Conversation

@joshistoast
Copy link
Copy Markdown
Collaborator

@joshistoast joshistoast commented May 13, 2026

Summary

Focuses on continuing the move away from the old docs configuration by removing legacy packages, tests and generate scripts, and replacing them with new scripts for the new docs.

  • Adds docs commands to Makefile
  • Removes old docs tests
  • Removes old docs generate scripts
  • Removes docstring and mkfile usage
  • Regenerated UV lockfile
  • Adds docs page for contributing to the docs
  • Upgrades deps

Related Issues / Discussions

QA Instructions

Merge Plan

Checklist

  • The PR has a short but descriptive title, suitable for a changelog
  • Tests added / updated (if applicable)
  • ❗Changes to a redux slice have a corresponding migration
  • Documentation added / updated (if applicable)
  • Updated What's New copy (if doing a release after this PR)

@github-actions github-actions Bot added CI-CD Continuous integration / Continuous delivery Root python-tests PRs that change python tests python-deps PRs that change python dependencies labels May 13, 2026
@lstein lstein self-assigned this May 15, 2026
@github-actions github-actions Bot added the docs PRs that change docs label May 15, 2026
@joshistoast
Copy link
Copy Markdown
Collaborator Author

I also have an opengraph image to add to the head, but I'd rather wait for #9161 to get merged to avoid merge conflicts

Focuses on continuing the move away from the old docs configuration by
removing legacy packages, tests and generate scripts, and replacing them
with new scripts for the new docs.ma

- Adds docs commands to Makefile
- Removes old docs tests
- Removes old docs generate scripts
- Removes docstring and mkfile usage
- Regenerated UV lockfile
Pulls out the long parts of the astro config into dedicated files
located in a new `config/` directory.
describe how to add images to your docs pages in an organized fashion.
@joshistoast joshistoast force-pushed the chore/remove-old-docs branch from 9c17e8f to df0e754 Compare May 23, 2026 19:22
@joshistoast joshistoast marked this pull request as ready for review May 23, 2026 19:52
@joshistoast
Copy link
Copy Markdown
Collaborator Author

Hold off on merging, found some docs additions that someone put in the wrong places.

@github-actions github-actions Bot added the frontend-deps PRs that change frontend dependencies label May 24, 2026
@joshistoast joshistoast changed the title Chore/remove old docs Docs: Housekeeping + Remove docs-old May 24, 2026
@JPPhoto
Copy link
Copy Markdown
Collaborator

JPPhoto commented May 24, 2026

  • invokeai/docs/src/config/redirects.ts - the node redirects need correction.

    • /nodes/NODES, /nodes/comfyToInvoke, and /nodes/communityNodes redirect to /workflows/..., but the migrated pages are under /features/workflows/....
    • These old links will 404 unless the redirect targets are updated.
    • Add a redirect-target validation test so every configured redirect resolves to an existing generated docs route.
  • invokeai/docs/src/content/docs/concepts/models.mdx - the orphaned model directory sync/delete workflow still needs documentation.

    • The code still exposes this feature through OrphanedModelsService, /api/v2/models/sync/orphaned, SyncModelsButton, and SyncModelsDialog.
    • The current docs only cover "Missing Files", which means database entries whose files are gone.
    • That is different from the sync workflow, which finds model directories on disk that are not referenced in the database.
    • The restored docs should be updated for current behavior: .gguf is included, the UI is admin-only, and deletion directly removes directories with shutil.rmtree().
  • invokeai/docs/src/content/docs/features/Canvas/canvas-projects.mdx - canvas projects still need developer documentation, not just user-facing docs.

    • The code confirms the technical format is current: .invk ZIP files contain manifest.json, canvas_state.json, params.json, ref_images.json, loras.json, and images/.
    • The implementation still has manifest version 1, image-name collection, server-existence checks, upload/remapping for missing images, and concurrency-limited image fetch/upload.
    • The old technical docs should be migrated under development docs, but updated to use the current UI entry points: the canvas toolbar archive menu and canvas context menu.
  • invokeai/docs-old/nodes/detailedNodes/faceTools.md - face Nodes still need a replacement docs page.

    • The code still defines FaceOff, FaceMask, and FaceIdentifier in facetools.py, category segmentation, version 1.2.2.
    • The old page is mostly still accurate: face IDs, minimum confidence, offsets, padding, chunking, invert mask, and outputs match the current code.
    • Refresh the wording against current field descriptions, then add a redirect from /nodes/detailedNodes/faceTools.

- fix redirects
- improve canvas projects docs
- improve models docs
@joshistoast
Copy link
Copy Markdown
Collaborator Author

@lstein this is all good to go

Copy link
Copy Markdown
Collaborator

@lstein lstein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JPPhoto comments addressed, so ready to go.

@lstein lstein enabled auto-merge (squash) May 26, 2026 20:32
@lstein lstein merged commit af37c23 into invoke-ai:main May 26, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI-CD Continuous integration / Continuous delivery docs PRs that change docs frontend-deps PRs that change frontend dependencies python-deps PRs that change python dependencies python-tests PRs that change python tests Root v6.13.x

Projects

Status: 6.13.x Theme: MODELS

Development

Successfully merging this pull request may close these issues.

3 participants